﻿//-----------------------------------------------------------------------
// <copyright file="MessageModule.cs" company="Nathan Miller">
// Copyright (c) Nathan Miller.
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
// 
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
// </copyright>
//-----------------------------------------------------------------------
namespace App.Modules.Message
{
    using App.Modules.Component;
    using TileTool.Log;
    using TileTool.Message;

    /// <summary>
    /// Application message module.
    /// </summary>
    public class MessageModule : Module
    {
        #region Constants - Private

        /// <summary>
        /// Log message group.
        /// </summary>
        private const string LogGroup = "MessageModule";

        #endregion

        #region Fields - Private

        /// <summary>
        /// Message manager to send all messages on.
        /// </summary>
        private IMessageManager messageManager = null;

        /// <summary>
        /// Channel all application messages will be sent on.
        /// </summary>
        private MessageChannel applicationMessageChannel = MessageChannel.Create();

        #endregion

        #region Properties - Public

        /// <summary>
        /// Gets the message manager for the application.
        /// </summary>
        public IMessageManager MessageManager
        {
            get
            {
                return this.messageManager;
            }
        }

        /// <summary>
        /// Gets the message router that all components of the
        /// application should use.
        /// </summary>
        public MessageRouter MessageRouter
        {
            get;
            private set;
        }

        #endregion

        #region Methods - Public

        /// <summary>
        /// Called when the application is starting up.
        /// </summary>
        public override void Startup()
        {
            LogSystem.LogStartup(LogGroup, "Starting...");

            ComponentModule component = GetModule<ComponentModule>();
            MessageManagerFactoryComponentBase factory = component.Get<MessageManagerFactoryComponentBase>(ComponentAliases.MessageManager);

            LogSystem.LogStartup(LogGroup, "Allocating message manager...");
            this.messageManager = factory.Allocate();
            MessageRouter = new MessageRouter(this.MessageManager, this.applicationMessageChannel);

            base.Startup();
        }

        /// <summary>
        /// Called when the application is shutting down.
        /// </summary>
        public override void Shutdown()
        {
            base.Shutdown();

            this.messageManager = null;
        }

        /// <summary>
        /// Handle module work.
        /// </summary>
        public override void Work()
        {
            base.Work();

            this.messageManager.DispatchMessages();
        }

        #endregion
    }
}
